Re: References and automatic numbering for figures and tables
Bastiaan Veelo <[email protected]> Tue, 28 Apr 2015 10:50:13 +0200
| Newsgroups | gmane.text.doxygen.devel |
|---|---|
| Message-ID | <[email protected]> |
--===============8178785151303305102== Content-Type: multipart/alternative; boundary="Apple-Mail=_2280FA24-E9B2-4994-A2A9-6352FF59AC5F" --Apple-Mail=_2280FA24-E9B2-4994-A2A9-6352FF59AC5F Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 +1 for generated labels to figures and tables. Just wanted to chime in, in support of this feature request. We do our = 400 page manual [1] in Doxygen, and referencing to figures is the one = thing that we still miss. All our figures are in \figure syntax, so I=E2=80=99d hope an = implementation would support that as well. I=E2=80=99d suggest using the stem of the figure file name as the label = name. That way, the syntax for images can stay the same. So, in the = below example, \ref fig_growth_vs_time would generate a link to the = figure (top of the figure, not the caption at the bottom). Tables in HTML format could probably be labeled using the <A = name=3D=E2=80=9C,,,=E2=80=9D> named anchor, for LaTeX output as well. Best regards, Bastiaan Veelo. [1] http://www.sarc.nl/pias/manuals/manuals-pias-fairway = <http://www.sarc.nl/pias/manuals/manuals-pias-fairway> > On 28 Apr 2015, at 01:26, Gavin Radolan <[email protected]> wrote: >=20 > Hello, >=20 > I'm using Doxygen to create a reference manual. Input is markdown. = Output is LaTeX and html. Currently using Doxygen 1.8.8. >=20 > I'm wondering if there are any plans for Doxygen to support automatic = numbering of figures and tables, with referencing capability from the = markdown text? >=20 > For example, behavior similar to the @section command's LaTeX output. = But separate enumeration for figures and another separate enumeration = for tables. And with the enumeration showing up in both LaTeX and html = output. >=20 > Syntax might be something like this, >=20 > At the figure: >=20 >  >=20 > or maybe >=20 >  > @figure fig_name "Growth rate vs time" >=20 > The first example is preferable for it's simplicity, but maybe it's = difficult to have ![Caption text ] used for multiple purposes... >=20 > At the table: >=20 > @table tab_name Growth rate data 2009 - 2014 >=20 > | Year | Growth Rate| > |:------:|-----------------:| > | 2009| 0.3245 | > ....whatever.... > =20 > In the body text: >=20 > The growth rate for the last five years is shown in \ref tab_name. As = can be seen in /ref fig_name, the growth rate is logarithmic. >=20 > In the generated pdf/html: >=20 > The growth rate for the last five years is shown in Table 93: Growth = rate 2009 - 2014. As can be seen in Figure 125: Growth rate vs time, the = growth rate is logarithmic. >=20 > So "Figure N" and "Table M" are automatically generated and pre-pended = to the caption for each figure/table in the document. And you can link = to any figure or table anyplace in the doc using a /ref tag.=20 >=20 > I've noticed some users implement similar functionality with = post-processing scripts or other "add-on" tools, such as doxynum. I = could do likewise, but first, wanted to ask whether or not there are = plans to have such functionality "built-in" to Doxygen - and if so, = approximately when? >=20 > Kind regards, >=20 > Gavin Radolan >=20 >=20 > = --------------------------------------------------------------------------= ---- > One dashboard for servers and applications across = Physical-Virtual-Cloud=20 > Widest out-of-the-box monitoring support with 50+ applications > Performance metrics, stats and reports that give you Actionable = Insights > Deep dive visibility with transaction tracing using APM Insight. > = http://ad.doubleclick.net/ddm/clk/290420510;117567292;y___________________= ____________________________ > Doxygen-develop mailing list > [email protected] > https://lists.sourceforge.net/lists/listinfo/doxygen-develop --Apple-Mail=_2280FA24-E9B2-4994-A2A9-6352FF59AC5F Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=utf-8 <html><head><meta http-equiv=3D"Content-Type" content=3D"text/html = charset=3Dutf-8"></head><body style=3D"word-wrap: break-word; = -webkit-nbsp-mode: space; -webkit-line-break: after-white-space;" = class=3D""><div class=3D"">+1 for generated labels to figures and = tables.</div><div class=3D""><br class=3D""></div><div class=3D"">Just = wanted to chime in, in support of this feature request. We do our 400 = page manual [1] in Doxygen, and referencing to figures is the one thing = that we still miss.</div><div class=3D""><br class=3D""></div><div = class=3D"">All our figures are in \figure syntax, so I=E2=80=99d hope an = implementation would support that as well.</div><div class=3D""><br = class=3D""></div><div class=3D"">I=E2=80=99d suggest using the stem of = the figure file name as the label name. That way, the syntax for images = can stay the same. So, in the below example, \ref fig_growth_vs_time = would generate a link to the figure (top of the figure, not the caption = at the bottom).</div><div class=3D""><br class=3D""></div><div = class=3D"">Tables in HTML format could probably be labeled using the = <A name=3D=E2=80=9C,,,=E2=80=9D> named anchor, for LaTeX output as = well.</div><div class=3D""><br class=3D""></div><div class=3D"">Best = regards,</div><div class=3D"">Bastiaan Veelo.</div><div class=3D""><br = class=3D""></div><div class=3D"">[1] <a = href=3D"http://www.sarc.nl/pias/manuals/manuals-pias-fairway" = class=3D"">http://www.sarc.nl/pias/manuals/manuals-pias-fairway</a></div><= div class=3D""><br class=3D""></div><br class=3D""><div><blockquote = type=3D"cite" class=3D""><div class=3D"">On 28 Apr 2015, at 01:26, Gavin = Radolan <<a href=3D"mailto:[email protected]" = class=3D"">[email protected]</a>> wrote:</div><br = class=3D"Apple-interchange-newline"><div class=3D""><meta = http-equiv=3D"Content-Type" content=3D"text/html; charset=3Dutf-8" = class=3D""><div dir=3D"ltr" class=3D""><div class=3D"">Hello,</div><div = class=3D""><br class=3D""></div><div class=3D"">I'm using Doxygen to = create a reference manual. Input is markdown. Output is LaTeX and html. = Currently using Doxygen 1.8.8.</div><div class=3D""><br = class=3D""></div><div class=3D"">I'm wondering if there are any plans = for Doxygen to support automatic numbering of figures and tables, with = referencing capability from the markdown text?</div><div class=3D""><br = class=3D""></div><div class=3D"">For example, behavior similar to the = @section command's LaTeX output. But separate enumeration for figures = and another separate enumeration for tables. And with the enumeration = showing up in both LaTeX and html output.</div><div class=3D""><br = class=3D""></div><div class=3D"">Syntax might be something like = this,</div><div class=3D""><br class=3D""></div><div class=3D"">At the = figure:</div><div class=3D""><br class=3D""></div><div class=3D""> = = </div><div class=3D""><br class=3D""></div><div class=3D"">or = maybe</div><div class=3D""><div class=3D""><br class=3D""></div><div = class=3D""> = </div></div><div class=3D""> = @figure fig_name "Growth rate vs time"<br class=3D""></div><div = class=3D""><br class=3D""></div><div class=3D"">The first example is = preferable for it's simplicity, but maybe it's difficult to have = ![Caption text ] used for multiple purposes...</div><div class=3D""><br = class=3D""></div><div class=3D"">At the table:</div><div class=3D""><br = class=3D""></div><blockquote style=3D"margin:0px 0px 0px = 40px;border:none;padding:0px" class=3D""><div class=3D"">@table tab_name = Growth rate data 2009 - 2014</div></blockquote><blockquote = style=3D"margin:0px 0px 0px 40px;border:none;padding:0px" class=3D""><div = class=3D""><br class=3D""></div><div class=3D"">| Year | Growth = Rate|</div><div = class=3D"">|:------:|-----------------:|</div></blockquote><blockquote = style=3D"margin:0px 0px 0px 40px;border:none;padding:0px" class=3D""><div = class=3D"">| 2009| 0.3245 = |</div></blockquote><blockquote style=3D"margin:0px 0px 0px = 40px;border:none;padding:0px" class=3D""><div = class=3D"">....whatever....</div><div class=3D""> = </div></blockquote><div class=3D"">In the body = text:</div><blockquote style=3D"margin:0px 0px 0px = 40px;border:none;padding:0px" class=3D""><div class=3D""><br = class=3D""></div><div class=3D"">The growth rate for the last five years = is shown in \ref tab_name. As can be seen in /ref fig_name, the growth = rate is logarithmic.</div></blockquote><div class=3D""><br = class=3D""></div><div class=3D"">In the generated pdf/html:</div><div = class=3D""><br class=3D""></div><blockquote style=3D"margin:0px 0px 0px = 40px;border:none;padding:0px" class=3D"">The growth rate for the last = five years is shown in Table 93: Growth rate 2009 - 2014. As can be seen = in Figure 125: Growth rate vs time, the growth rate is logarithmic.<br = class=3D""><br class=3D""></blockquote>So "Figure N" and "Table M" are = automatically generated and pre-pended to the caption for each = figure/table in the document. And you can link to any figure or table = anyplace in the doc using a /ref tag. <div class=3D""><br = class=3D""><div class=3D"">I've noticed some users implement similar = functionality with post-processing scripts or other "add-on" tools, such = as doxynum. I could do likewise, but first, wanted to ask whether or not = there are plans to have such functionality "built-in" to Doxygen - and = if so, approximately when?</div><div class=3D""><br class=3D""></div><div = class=3D""><div dir=3D"ltr" class=3D"">Kind regards,<div class=3D""><br = class=3D""></div><div class=3D"">Gavin Radolan</div><div class=3D""><br = class=3D""></div><div class=3D""><br class=3D""></div></div></div> </div></div> = --------------------------------------------------------------------------= ----<br class=3D"">One dashboard for servers and applications across = Physical-Virtual-Cloud <br class=3D"">Widest out-of-the-box monitoring = support with 50+ applications<br class=3D"">Performance metrics, stats = and reports that give you Actionable Insights<br class=3D"">Deep dive = visibility with transaction tracing using APM Insight.<br class=3D""><a = href=3D"http://ad.doubleclick.net/ddm/clk/290420510;117567292;y___________= ____________________________________" = class=3D"">http://ad.doubleclick.net/ddm/clk/290420510;117567292;y________= _______________________________________</a><br class=3D"">Doxygen-develop = mailing list<br class=3D"">[email protected]<br = class=3D"">https://lists.sourceforge.net/lists/listinfo/doxygen-develop<br= class=3D""></div></blockquote></div><br class=3D""></body></html>= --Apple-Mail=_2280FA24-E9B2-4994-A2A9-6352FF59AC5F-- --===============8178785151303305102== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline ------------------------------------------------------------------------------ One dashboard for servers and applications across Physical-Virtual-Cloud Widest out-of-the-box monitoring support with 50+ applications Performance metrics, stats and reports that give you Actionable Insights Deep dive visibility with transaction tracing using APM Insight. http://ad.doubleclick.net/ddm/clk/290420510;117567292;y --===============8178785151303305102== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Doxygen-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/doxygen-develop --===============8178785151303305102==--